<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>src/node/class.node.webview.js - SceneGraph.js</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><img src="../../logo/logoCGSG_256x57.png" title="SceneGraph.js"></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: 2.2.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
            <li><a href="#api-modules">Modules</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="../classes/CGSG.html">CGSG</a></li>
            
                <li><a href="../classes/CGSGAccordion.html">CGSGAccordion</a></li>
            
                <li><a href="../classes/CGSGAnimationManager.html">CGSGAnimationManager</a></li>
            
                <li><a href="../classes/CGSGAnimationMethod.html">CGSGAnimationMethod</a></li>
            
                <li><a href="../classes/CGSGBindEntry.html">CGSGBindEntry</a></li>
            
                <li><a href="../classes/CGSGButtonMode.html">CGSGButtonMode</a></li>
            
                <li><a href="../classes/CGSGCollisionGhostOnDemandTester.html">CGSGCollisionGhostOnDemandTester</a></li>
            
                <li><a href="../classes/CGSGCollisionManager.html">CGSGCollisionManager</a></li>
            
                <li><a href="../classes/CGSGCollisionMethod.html">CGSGCollisionMethod</a></li>
            
                <li><a href="../classes/CGSGCollisionRegionTester.html">CGSGCollisionRegionTester</a></li>
            
                <li><a href="../classes/CGSGCollisionTesterFactory.html">CGSGCollisionTesterFactory</a></li>
            
                <li><a href="../classes/CGSGColor.html">CGSGColor</a></li>
            
                <li><a href="../classes/CGSGCSSManager.html">CGSGCSSManager</a></li>
            
                <li><a href="../classes/CGSGDimension.html">CGSGDimension</a></li>
            
                <li><a href="../classes/CGSGEvent.html">CGSGEvent</a></li>
            
                <li><a href="../classes/CGSGEventManager.html">CGSGEventManager</a></li>
            
                <li><a href="../classes/CGSGHandleBox.html">CGSGHandleBox</a></li>
            
                <li><a href="../classes/CGSGImgManager.html">CGSGImgManager</a></li>
            
                <li><a href="../classes/CGSGInterpolator.html">CGSGInterpolator</a></li>
            
                <li><a href="../classes/CGSGInterpolatorLinear.html">CGSGInterpolatorLinear</a></li>
            
                <li><a href="../classes/CGSGInterpolatorTCB.html">CGSGInterpolatorTCB</a></li>
            
                <li><a href="../classes/CGSGKeyFrame.html">CGSGKeyFrame</a></li>
            
                <li><a href="../classes/CGSGMap.html">CGSGMap</a></li>
            
                <li><a href="../classes/CGSGMask.html">CGSGMask</a></li>
            
                <li><a href="../classes/CGSGMaskCache.html">CGSGMaskCache</a></li>
            
                <li><a href="../classes/CGSGMaskClip.html">CGSGMaskClip</a></li>
            
                <li><a href="../classes/CGSGMath.html">CGSGMath</a></li>
            
                <li><a href="../classes/CGSGNode.html">CGSGNode</a></li>
            
                <li><a href="../classes/CGSGNodeButton.html">CGSGNodeButton</a></li>
            
                <li><a href="../classes/CGSGNodeCircle.html">CGSGNodeCircle</a></li>
            
                <li><a href="../classes/CGSGNodeColorPicker.html">CGSGNodeColorPicker</a></li>
            
                <li><a href="../classes/CGSGNodeCurveTCB.html">CGSGNodeCurveTCB</a></li>
            
                <li><a href="../classes/CGSGNodeDomElement.html">CGSGNodeDomElement</a></li>
            
                <li><a href="../classes/CGSGNodeEllipse.html">CGSGNodeEllipse</a></li>
            
                <li><a href="../classes/CGSGNodeImage.html">CGSGNodeImage</a></li>
            
                <li><a href="../classes/CGSGNodeLine.html">CGSGNodeLine</a></li>
            
                <li><a href="../classes/CGSGNodeSlider.html">CGSGNodeSlider</a></li>
            
                <li><a href="../classes/CGSGNodeSliderHandle.html">CGSGNodeSliderHandle</a></li>
            
                <li><a href="../classes/CGSGNodeSprite.html">CGSGNodeSprite</a></li>
            
                <li><a href="../classes/CGSGNodeSquare.html">CGSGNodeSquare</a></li>
            
                <li><a href="../classes/CGSGNodeTabMenu.html">CGSGNodeTabMenu</a></li>
            
                <li><a href="../classes/CGSGNodeText.html">CGSGNodeText</a></li>
            
                <li><a href="../classes/CGSGNodeWebview.html">CGSGNodeWebview</a></li>
            
                <li><a href="../classes/CGSGParticle.html">CGSGParticle</a></li>
            
                <li><a href="../classes/CGSGParticleEmitter.html">CGSGParticleEmitter</a></li>
            
                <li><a href="../classes/CGSGParticleSystem.html">CGSGParticleSystem</a></li>
            
                <li><a href="../classes/CGSGPickNodeMethod.html">CGSGPickNodeMethod</a></li>
            
                <li><a href="../classes/CGSGPosition.html">CGSGPosition</a></li>
            
                <li><a href="../classes/CGSGRegion.html">CGSGRegion</a></li>
            
                <li><a href="../classes/CGSGRotation.html">CGSGRotation</a></li>
            
                <li><a href="../classes/CGSGScale.html">CGSGScale</a></li>
            
                <li><a href="../classes/CGSGSceneGraph.html">CGSGSceneGraph</a></li>
            
                <li><a href="../classes/CGSGSection.html">CGSGSection</a></li>
            
                <li><a href="../classes/CGSGTimeline.html">CGSGTimeline</a></li>
            
                <li><a href="../classes/CGSGTraverser.html">CGSGTraverser</a></li>
            
                <li><a href="../classes/CGSGVector2D.html">CGSGVector2D</a></li>
            
                <li><a href="../classes/CGSGView.html">CGSGView</a></li>
            
                <li><a href="../classes/CGSGWEBVIEWMODE.html">CGSGWEBVIEWMODE</a></li>
            
                <li><a href="../classes/CGSGWrapMode.html">CGSGWrapMode</a></li>
            
                <li><a href="../classes/GLOBAL_CONSTANTS.html">GLOBAL_CONSTANTS</a></li>
            
                <li><a href="../classes/GLOBAL_METHODS.html">GLOBAL_METHODS</a></li>
            
                <li><a href="../classes/GLOBAL_PROPERTIES.html">GLOBAL_PROPERTIES</a></li>
            
                <li><a href="../classes/UTIL_ARRAY.html">UTIL_ARRAY</a></li>
            
                <li><a href="../classes/WUICCGSGNodeImageFactory.html">WUICCGSGNodeImageFactory</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="../modules/Animation.html">Animation</a></li>
            
                <li><a href="../modules/Collision.html">Collision</a></li>
            
                <li><a href="../modules/Math.html">Math</a></li>
            
                <li><a href="../modules/Node.html">Node</a></li>
            
                <li><a href="../modules/ParticleSystem.html">ParticleSystem</a></li>
            
                <li><a href="../modules/Scene.html">Scene</a></li>
            
                <li><a href="../modules/Util.html">Util</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked>
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>


            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1 class="file-heading">File: src/node/class.node.webview.js</h1>

<div class="file">
    <pre class="code prettyprint linenums">
/*
 * Copyright (c) 2014 Gwennael Buchet
 *
 * License/Terms of Use
 *
 * Permission is hereby granted, free of charge and for the term of intellectual property rights on the Software, to any
 * person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to use, copy, modify
 * and propagate free of charge, anywhere in the world, all or part of the Software subject to the following mandatory conditions:
 *
 *   •    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 *  Any failure to comply with the above shall automatically terminate the license and be construed as a breach of these
 *  Terms of Use causing significant harm to Gwennael Buchet.
 *
 *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *  Except as contained in this notice, the name of Gwennael Buchet shall not be used in advertising or otherwise to promote
 *  the use or other dealings in this Software without prior written authorization from Gwennael Buchet.
 *
 *  These Terms of Use are subject to French law.
 */

/**
 * The different rendering mode
 * @class CGSGWEBVIEWMODE
 * @type {Object}
 * @author Gwennael Buchet (gwennael.buchet@gmail.com)
 */
var CGSGWEBVIEWMODE = {
    /**
     * @property LIVE
     */
    LIVE   : 0,
    /**
     * @property PREVIEW
     */
    PREVIEW: 1
};

/*
 * TODO :
 * - When resize or drag : switch to PREVIEW mode to allow mouse over the webview
 * - load a page in AJAX and make an image from it to assign to the PREVIEW mode
 */

/**
 * @class CGSGNodeWebview
 * @module Node
 * @extends CGSGNodeDomElement
 * @constructor
 * @param {Number} x Relative position on X
 * @param {Number} y Relative position on Y
 * @param {Number} width Relative dimension
 * @param {Number} height Relative Dimension
 * @param {String} url URL of the webpage
 * @type {CGSGNodeWebview}
 */
var CGSGNodeWebview = CGSGNodeDomElement.extend(
    {
        initialize: function (x, y, width, height, url) {
            this._super(x, y, width, height, document.createElement(&quot;iframe&quot;));

            this.resizeTo(CGSGMath.fixedPoint(width), CGSGMath.fixedPoint(height));

            /**
             * Size of the area around the webview in LIVE mode
             * @property threshold
             * @default 20
             * @type {Number}
             */
            this.threshold = 20;

            /**
             * @property classType
             * @type {String}
             */
            this.classType = &quot;CGSGNodeWebview&quot;;

            /**
             * A CGSGNodeImage rendering the preview of the webpage
             * @property _previewContainer
             * @type {CGSGNodeImage}
             * @private
             */
            this._previewContainer = null;

            /**
             * URL of the web page
             * @property _url
             * @type {String}
             * @private
             */
            this._url = url;

            /**
             * URL for the preview mode
             * @property _previewURL
             * @private
             * @type {String}
             */
            this._previewURL = null;

            this._createLiveContainer();
            this._createPreviewContainer();

            this.switchMode(CGSGWEBVIEWMODE.LIVE);
        },

        /**
         * Initialize and add the live container to the HTML body
         * @method _initLiveContainer
         * @private
         */
        _initLiveContainer: function () {
            if (!cgsgExist(this._htmlElement)) {
                this._createLiveContainer();
            }

            document.body.appendChild(this._htmlElement);
        },

        /**
         * Initialize and add the CGSGNodeImage
         * @method _initPreviewContainer
         * @private
         */
        _initPreviewContainer: function () {
            if (!cgsgExist(this._previewContainer)) {
                this._createPreviewContainer();
            }

            this.addChild(this._previewContainer);

            //load the webcontent via Ajax
            //this._loadPageAsync();
        },

        /**
         * Create an IFRAME tag in the _liveContainer property
         * @method _createLiveContainer
         * @private
         */
        _createLiveContainer: function () {
            var uri = &quot;&quot;;
            if (cgsgExist(this._url)) {
                uri = this._url;
            }

            this._htmlElement.style.position = &quot;absolute&quot;;
            this._htmlElement.setAttribute(&quot;src&quot;, uri);
        },

        /**
         * Create the CGSGNodeImage to contain the preview
         * @method _createPreviewContainer
         * @private
         */
        _createPreviewContainer: function () {
            this._previewContainer =
            new CGSGNodeImage(0, 0, this._previewURL);

            this._previewContainer.isTraversable = false;
        },

        /*
         *
         * @private
         * @method _loadPageAsync
         */
        /*_loadPageAsync : function () {

         },*/

        /**
         * @method setURL
         * @param {String} url
         */
        setURL: function (url) {
            this._url = url;

            if (cgsgExist(this._htmlElement)) {
                this._htmlElement.setAttribute(&quot;src&quot;, this._url);
            }
        },

        /**
         * Get a String representing the URL
         * @method getURL
         * @return {string}
         */
        getURL: function () {
            return this._url;
        },

        /**
         * Set the URL of the image for the preview mode (CGSGWEBVIEWMODE.PREVIEW)
         * @method setPreviewURL
         * @param {String} imageURL
         */
        setPreviewURL: function (imageURL) {
            this._previewURL = imageURL;
            this._previewContainer.setURL(this._previewURL);
        },

        /**
         * Switch between rendering mode
         * @method switchMode
         * @param {Number} mode a CGSGWEBVIEWMODE enum : LIVE or PREVIEW
         */
        switchMode: function (mode) {
            if (mode === CGSGWEBVIEWMODE.LIVE) {
                this.detachChild(this._previewContainer);
                this._initLiveContainer();
            }
            else {
                //Initially, there is no mode, so we cannot remove the child from the Body
                if (this._mode === CGSGWEBVIEWMODE.LIVE) {
                    document.body.removeChild(this._htmlElement);
                }
                this._initPreviewContainer();
            }

            this._mode = mode;
        },

        /**
         * @method getCurrentMode
         * @return {CGSGWEBVIEWMODE} the current mode
         */
        getCurrentMode: function () {
            return this._mode;
        },

        /**
         * @protected
         * @method render
         * Custom rendering
         * */
        render: function (context) {
            if (this._mode === CGSGWEBVIEWMODE.LIVE) {
                //context.fillStyle = this.bkgcolors[0];
                //context.strokeStyle = this.lineColor;
                //context.lineWidth = this.lineWidth;

                //we draw the rect at (0,0) because we have already translated the context to the correct position
                context.fillRect(0, 0, this.dimension.width, this.dimension.height);

                context.strokeRect(0, 0, this.dimension.width, this.dimension.height);

                context.strokeRect(this.threshold - 2, this.threshold - 2,
                                   8 + this.dimension.width - this.threshold * 2,
                                   8 + this.dimension.height - this.threshold * 2);

                if (cgsgExist(this._htmlElement)) {
                    this._htmlElement.style.left = (this.getAbsLeft() + this.threshold) + &quot;px&quot;;
                    this._htmlElement.style.top = (this.getAbsTop() + this.threshold) + &quot;px&quot;;
                    this._htmlElement.style.width = (this.getAbsWidth() - this.threshold * 2) + &quot;px&quot;;
                    this._htmlElement.style.height = (this.getAbsHeight() - this.threshold * 2) + &quot;px&quot;;
                }
            }
            else {
                this._previewContainer.resizeTo(this.getWidth(), this.getHeight());

                //draw this zone
                //context.fillStyle = this.bkgcolors[0];

                //we draw the rect at (0,0) because we have already translated the context to the correct position
                context.fillRect(0, 0, this.getWidth(), this.getHeight());
            }
        },

        /**
         * Free the memory taken by this node
         * @method free
         */
        free: function () {
            if (cgsgExist(this._htmlElement)) {
                CGSG.canvas.removeChild(this._htmlElement);
                delete (this._htmlElement);
            }

            this._super();
        },

        /**
         * Return the copy of this node
         * @method copy
         * @return {CGSGNodeWebview}
         */
        copy: function () {
            var node = new CGSGNodeWebview(this.position.x, this.position.y, this.dimension.width,
                                           this.dimension.height, this.url);
            //call the super method
            node = this._super(node);

            node.threshold = this.threshold;

            node.switchMode(this.mode);

            return node;
        }
    }
);

    </pre>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
